<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs for page GetSearchKeys.php</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/library/GetSearchKeys.php</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-functions">Functions</a>
			</div>
	<div class="info-box-body">	
		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Copyright (c) 2009, Microsoft  All rights reserved.</p>
<p class="description"><p>Redistribution and use in source and binary forms, with or without  modification, are permitted provided that the following conditions are met:      * Redistributions of source code must retain the above copyright        notice, this list of conditions and the following disclaimer.      * Redistributions in binary form must reproduce the above copyright        notice, this list of conditions and the following disclaimer in the        documentation and/or other materials provided with the distribution.      * Neither the name of RealDolmen nor the        names of its contributors may be used to endorse or promote products        derived from this software without specific prior written permission.</p><p>THIS SOFTWARE IS PROVIDED BY Microsoft ''AS IS'' AND ANY  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE  DISCLAIMED. IN NO EVENT SHALL RealDolmen BE LIABLE FOR ANY  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> <p>a-jetann</p><p>Gathers search keys from request URI and prepares for Bing search  query.</p></li>
				<li><span class="field">version:</span> $Id: GetSearchKeys.php, v 1.0 2009-10-09 08:00:00Z unknown $</li>
				<li><span class="field">copyright:</span> Copyright (c) 2009, Microsoft (http://www.microsoft.com)</li>
			</ul>
		
			</div>
</div>
		

	
	
	
	<a name="sec-functions"></a>	
	<div class="info-box">
		<div class="info-box-title">Functions</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<span class="disabled">Functions</span>
		</div>
		<div class="info-box-body">	
			<a name="functionweb_error_clean_up_maximum_keys" id="functionweb_error_clean_up_maximum_keys"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../../media/images/Function.png" />
		<span class="method-title">web_error_clean_up_maximum_keys</span> (line <span class="line-number">195</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">return:</span> Success status.</li>
				<li><span class="field">copyright:</span> Copyright (c) 2009, Microsoft (http://www.microsoft.com)</li>
				<li><span class="field">license:</span> Cleanup</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			web_error_clean_up_maximum_keys
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$keys</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$keys</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$keys</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$keys</span>			</li>
				</ul>
		
	
</div>
<a name="functionweb_error_get_bing_search_keys" id="functionweb_error_get_bing_search_keys"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../../media/images/Function.png" />
		<span class="method-title">web_error_get_bing_search_keys</span> (line <span class="line-number">46</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Acquire search keys for provided request URI.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Success status</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			web_error_get_bing_search_keys
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$requestUriStr</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$requestUriStr</span>			</li>
				</ul>
		
	
</div>
<a name="functionweb_error_get_bing_site_domains" id="functionweb_error_get_bing_site_domains"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../../media/images/Function.png" />
		<span class="method-title">web_error_get_bing_site_domains</span> (line <span class="line-number">255</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add domains (site) to gathered search keys.</p>
<p class="description"><p>Site domain values are set within BingIncludedDomains.  If domain site is provided within BingIncludedDomains,  then general Web search is performed instead.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Success status.</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			web_error_get_bing_site_domains
		</span>
				()
			</div>

		
	
</div>
<a name="functionweb_error_prepare_search_terms" id="functionweb_error_prepare_search_terms"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../../media/images/Function.png" />
		<span class="method-title">web_error_prepare_search_terms</span> (line <span class="line-number">222</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Prepare gathered keys for search term.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Success status.</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			web_error_prepare_search_terms
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$keys</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$keys</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$keys</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$keys</span>			</li>
				</ul>
		
	
</div>
<a name="functionweb_error_remove_empty_keys" id="functionweb_error_remove_empty_keys"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../../media/images/Function.png" />
		<span class="method-title">web_error_remove_empty_keys</span> (line <span class="line-number">165</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove any items in keys array that are empty.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Success status.</li>
			</ul>
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			web_error_remove_empty_keys
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$keys</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$keys</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$keys</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$keys</span>			</li>
				</ul>
		
	
</div>
		</div>
	</div>
	
	<p class="notes" id="credit">
		Documentation generated on Fri, 09 Oct 2009 18:41:05 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>